Refactor common parts from the Rounding class into a separate 'round' package #11023

ketanv3 · 2023-10-31T11:10:35Z

Description

The Rounding class (permalink) is a 1.5K SLOC monolith which is closely tied to rounding down timestamp values. This PR aims to simplify this class by:

Decoupling generic rounding classes (i.e., the ones not related to rounding of timestamp values) into a separate common package.
Creating the common package under the :libs:opensearch-common module as it's no longer tied to the :server module.

Related Issues

This is a prerequisite for #10392 which requires parts of the Rounding class to be overridden with SIMD features on supported JDKs. Since Multi-Release JAR replaces the entire class file (no way to replace just the inner classes), it creates too much code duplication. Splitting the Rounding class into smaller pieces and overriding them is much better.

relates #5910 - refactor to support modularity
relates #8110 - JPMS meta issue

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)
~~Public documentation issue/PR created~~

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

… package Signed-off-by: Ketan Verma <ketan9495@gmail.com>

github-actions · 2023-10-31T11:40:01Z

Compatibility status:

Checks if related components are compatible with change 370cdad

Incompatible components

Incompatible components: [https://github.com/opensearch-project/performance-analyzer.git]

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/performance-analyzer-rca.git]

github-actions · 2023-10-31T11:55:52Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/29355/
CommitID: 7cf6fc7
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

ketanv3 · 2023-10-31T12:03:53Z

All unrelated test failures:

Signed-off-by: Ketan Verma <ketan9495@gmail.com>

github-actions · 2023-11-01T07:37:14Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/29424/
CommitID: 3d7a3f4

kkmr

My memory of this is that if number of elements is < 64, we use LinearSearch, if number of elements < 128, we use BinarySearch. Is that not accurate? I think I added a comment to that effect in the previous PR.

ketanv3 · 2023-11-03T12:38:32Z

My memory of this is that if number of elements is < 64, we use LinearSearch, if number of elements < 128, we use BinarySearch. Is that not accurate? I think I added a comment to that effect in the previous PR.

@kkmr Yes, that still holds true for the date_histogram aggregation.

This PR refactors out the common parts that aren't related to timestamps or aggregations. It simply provides the fastest implementation of Roundable for any input size. The responsibility of using array-based prepared rounding if the size is <= 128 is kept with the caller (here).

ketanv3 · 2023-11-07T05:52:57Z

@nknize @reta Are we good to merge this PR?

ketanv3 · 2023-11-09T16:46:38Z

Ping @nknize

libs/common/src/main/java/org/opensearch/common/round/BidirectionalLinearSearcher.java

libs/common/src/main/java/org/opensearch/common/round/BinarySearcher.java

Signed-off-by: Ketan Verma <ketan9495@gmail.com>

github-actions · 2023-11-14T19:41:08Z

✅ Gradle check result for 370cdad: SUCCESS

ketanv3 · 2023-11-15T19:14:43Z

@andrross Are we all set to merge this PR? I have another draft PR (#11194) that hinges upon these changes.

Nick's comment has been addressed

opensearch-trigger-bot · 2023-11-15T21:59:44Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-11023-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 08db961e1914d93ce9d81e6da84e6e232b8d37e2
# Push it to GitHub
git push --set-upstream origin backport/backport-11023-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-11023-to-2.x.

…eparate 'round' package (opensearch-project#11023) (cherry picked from commit 08db961) Signed-off-by: Ketan Verma <ketan9495@gmail.com>

…eparate 'round' package (#11023) (#11223) (cherry picked from commit 08db961) Signed-off-by: Ketan Verma <ketan9495@gmail.com>

… package (opensearch-project#11023) * Refactor common parts from the Rounding class into a separate 'round' package Signed-off-by: Ketan Verma <ketan9495@gmail.com> * Move RoundableTests from :server to :libs:opensearch-common module Signed-off-by: Ketan Verma <ketan9495@gmail.com> * Address PR comments Signed-off-by: Ketan Verma <ketan9495@gmail.com> * Replace assert with IllegalArgumentException for size checks Signed-off-by: Ketan Verma <ketan9495@gmail.com> --------- Signed-off-by: Ketan Verma <ketan9495@gmail.com>

… package (opensearch-project#11023) * Refactor common parts from the Rounding class into a separate 'round' package Signed-off-by: Ketan Verma <ketan9495@gmail.com> * Move RoundableTests from :server to :libs:opensearch-common module Signed-off-by: Ketan Verma <ketan9495@gmail.com> * Address PR comments Signed-off-by: Ketan Verma <ketan9495@gmail.com> * Replace assert with IllegalArgumentException for size checks Signed-off-by: Ketan Verma <ketan9495@gmail.com> --------- Signed-off-by: Ketan Verma <ketan9495@gmail.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

Refactor common parts from the Rounding class into a separate 'round'…

7cf6fc7

… package Signed-off-by: Ketan Verma <ketan9495@gmail.com>

ketanv3 marked this pull request as ready for review October 31, 2023 11:57

Merge remote-tracking branch 'origin/main' into refactor/rounding

3d7a3f4

Signed-off-by: Ketan Verma <ketan9495@gmail.com>

ketanv3 force-pushed the refactor/rounding branch from 4fa4712 to 3d7a3f4 Compare November 1, 2023 06:44

kkmr reviewed Nov 2, 2023

View reviewed changes

kkmr approved these changes Nov 6, 2023

View reviewed changes

andrross reviewed Nov 14, 2023

View reviewed changes

ketanv3 added 2 commits November 15, 2023 00:12

Merge remote-tracking branch 'origin/main' into refactor/rounding

e050b04

Replace assert with IllegalArgumentException for size checks

370cdad

Signed-off-by: Ketan Verma <ketan9495@gmail.com>

ketanv3 requested review from adnapibar and tlfeng as code owners November 14, 2023 18:52

ketanv3 requested a review from andrross November 14, 2023 19:04

andrross approved these changes Nov 15, 2023

View reviewed changes

andrross added the backport 2.x Backport to 2.x branch label Nov 15, 2023

andrross merged commit 08db961 into opensearch-project:main Nov 15, 2023
41 checks passed

opensearch-trigger-bot bot added the backport-failed label Nov 15, 2023

ketanv3 mentioned this pull request Nov 15, 2023

[Backport 2.x] Refactor common parts from the Rounding class into a separate 'round' package (#11023) #11223

Merged

8 tasks

reta pushed a commit that referenced this pull request Nov 16, 2023

[Backport 2.x] Refactor common parts from the Rounding class into a s…

39baeb8

…eparate 'round' package (#11023) (#11223) (cherry picked from commit 08db961) Signed-off-by: Ketan Verma <ketan9495@gmail.com>

BrewTestBot mentioned this pull request Feb 21, 2024

opensearch 2.12.0 Homebrew/homebrew-core#163463

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor common parts from the Rounding class into a separate 'round' package #11023

Refactor common parts from the Rounding class into a separate 'round' package #11023

ketanv3 commented Oct 31, 2023 •

edited by nknize

Loading

github-actions bot commented Oct 31, 2023 •

edited

Loading

github-actions bot commented Oct 31, 2023

ketanv3 commented Oct 31, 2023

github-actions bot commented Nov 1, 2023

kkmr left a comment

ketanv3 commented Nov 3, 2023 •

edited

Loading

ketanv3 commented Nov 7, 2023

ketanv3 commented Nov 9, 2023

github-actions bot commented Nov 14, 2023

ketanv3 commented Nov 15, 2023

opensearch-trigger-bot bot commented Nov 15, 2023

Refactor common parts from the Rounding class into a separate 'round' package #11023

Refactor common parts from the Rounding class into a separate 'round' package #11023

Conversation

ketanv3 commented Oct 31, 2023 • edited by nknize Loading

Description

Related Issues

Check List

github-actions bot commented Oct 31, 2023 • edited Loading

Compatibility status:

Incompatible components

Skipped components

Compatible components

github-actions bot commented Oct 31, 2023

Gradle Check (Jenkins) Run Completed with:

ketanv3 commented Oct 31, 2023

github-actions bot commented Nov 1, 2023

Gradle Check (Jenkins) Run Completed with:

kkmr left a comment

Choose a reason for hiding this comment

ketanv3 commented Nov 3, 2023 • edited Loading

ketanv3 commented Nov 7, 2023

ketanv3 commented Nov 9, 2023

github-actions bot commented Nov 14, 2023

ketanv3 commented Nov 15, 2023

opensearch-trigger-bot bot commented Nov 15, 2023

ketanv3 commented Oct 31, 2023 •

edited by nknize

Loading

github-actions bot commented Oct 31, 2023 •

edited

Loading

ketanv3 commented Nov 3, 2023 •

edited

Loading